<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.configuration.beanutils;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.lang.reflect.Array;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.Collection;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.beanutils.DynaBean;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.beanutils.DynaClass;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.commons.configuration.Configuration;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.commons.configuration.ConfigurationMap;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.commons.configuration.SubsetConfiguration;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.commons.logging.Log;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.commons.logging.LogFactory;<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>    /**<a name="line.32"></a>
<FONT color="green">033</FONT>     * The &lt;tt&gt;ConfigurationDynaBean&lt;/tt&gt; dynamically reads and writes<a name="line.33"></a>
<FONT color="green">034</FONT>     * configurations properties from a wrapped configuration-collection<a name="line.34"></a>
<FONT color="green">035</FONT>     * {@link org.apache.commons.configuration.Configuration} instance. It also<a name="line.35"></a>
<FONT color="green">036</FONT>     * implements a {@link java.util.Map} interface so that it can be used in<a name="line.36"></a>
<FONT color="green">037</FONT>     * JSP 2.0 Expression Language expressions.<a name="line.37"></a>
<FONT color="green">038</FONT>     *<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;p&gt;The {@code ConfigurationDynaBean} maps nested and mapped properties<a name="line.39"></a>
<FONT color="green">040</FONT>     * to the appropriate {@code Configuration} subset using the<a name="line.40"></a>
<FONT color="green">041</FONT>     * {@link org.apache.commons.configuration.Configuration#subset}<a name="line.41"></a>
<FONT color="green">042</FONT>     * method. Similarly, indexed properties reference lists of configuration<a name="line.42"></a>
<FONT color="green">043</FONT>     * properties using the<a name="line.43"></a>
<FONT color="green">044</FONT>     * {@link org.apache.commons.configuration.Configuration#getList(String)}<a name="line.44"></a>
<FONT color="green">045</FONT>     * method. Setting an indexed property is supported, too.&lt;/p&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     *<a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;p&gt;Note: Some of the methods expect that a dot (&amp;quot;.&amp;quot;) is used as<a name="line.47"></a>
<FONT color="green">048</FONT>     * property delimiter for the wrapped configuration. This is true for most of<a name="line.48"></a>
<FONT color="green">049</FONT>     * the default configurations. Hierarchical configurations, for which a specific<a name="line.49"></a>
<FONT color="green">050</FONT>     * expression engine is set, may cause problems.&lt;/p&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>     *<a name="line.51"></a>
<FONT color="green">052</FONT>     * @author &lt;a href="mailto:ricardo.gladwell@btinternet.com"&gt;Ricardo Gladwell&lt;/a&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     * @version $Id: ConfigurationDynaBean.java 1366932 2012-07-29 20:06:31Z oheger $<a name="line.53"></a>
<FONT color="green">054</FONT>     * @since 1.0-rc1<a name="line.54"></a>
<FONT color="green">055</FONT>     */<a name="line.55"></a>
<FONT color="green">056</FONT>    public class ConfigurationDynaBean extends ConfigurationMap implements DynaBean<a name="line.56"></a>
<FONT color="green">057</FONT>    {<a name="line.57"></a>
<FONT color="green">058</FONT>        /** Constant for the property delimiter.*/<a name="line.58"></a>
<FONT color="green">059</FONT>        private static final String PROPERTY_DELIMITER = ".";<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        /** The logger.*/<a name="line.61"></a>
<FONT color="green">062</FONT>        private static final Log LOG = LogFactory.getLog(ConfigurationDynaBean.class);<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>        /**<a name="line.64"></a>
<FONT color="green">065</FONT>         * Creates a new instance of {@code ConfigurationDynaBean} and sets<a name="line.65"></a>
<FONT color="green">066</FONT>         * the configuration this bean is associated with.<a name="line.66"></a>
<FONT color="green">067</FONT>         *<a name="line.67"></a>
<FONT color="green">068</FONT>         * @param configuration the configuration<a name="line.68"></a>
<FONT color="green">069</FONT>         */<a name="line.69"></a>
<FONT color="green">070</FONT>        public ConfigurationDynaBean(Configuration configuration)<a name="line.70"></a>
<FONT color="green">071</FONT>        {<a name="line.71"></a>
<FONT color="green">072</FONT>            super(configuration);<a name="line.72"></a>
<FONT color="green">073</FONT>            if (LOG.isTraceEnabled())<a name="line.73"></a>
<FONT color="green">074</FONT>            {<a name="line.74"></a>
<FONT color="green">075</FONT>                LOG.trace("ConfigurationDynaBean(" + configuration + ")");<a name="line.75"></a>
<FONT color="green">076</FONT>            }<a name="line.76"></a>
<FONT color="green">077</FONT>        }<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        public void set(String name, Object value)<a name="line.79"></a>
<FONT color="green">080</FONT>        {<a name="line.80"></a>
<FONT color="green">081</FONT>            if (LOG.isTraceEnabled())<a name="line.81"></a>
<FONT color="green">082</FONT>            {<a name="line.82"></a>
<FONT color="green">083</FONT>                LOG.trace("set(" + name + "," + value + ")");<a name="line.83"></a>
<FONT color="green">084</FONT>            }<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>            if (value == null)<a name="line.86"></a>
<FONT color="green">087</FONT>            {<a name="line.87"></a>
<FONT color="green">088</FONT>                throw new NullPointerException("Error trying to set property to null.");<a name="line.88"></a>
<FONT color="green">089</FONT>            }<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>            if (value instanceof Collection)<a name="line.91"></a>
<FONT color="green">092</FONT>            {<a name="line.92"></a>
<FONT color="green">093</FONT>                Collection&lt;?&gt; collection = (Collection&lt;?&gt;) value;<a name="line.93"></a>
<FONT color="green">094</FONT>                for (Object v : collection)<a name="line.94"></a>
<FONT color="green">095</FONT>                {<a name="line.95"></a>
<FONT color="green">096</FONT>                    getConfiguration().addProperty(name, v);<a name="line.96"></a>
<FONT color="green">097</FONT>                }<a name="line.97"></a>
<FONT color="green">098</FONT>            }<a name="line.98"></a>
<FONT color="green">099</FONT>            else if (value.getClass().isArray())<a name="line.99"></a>
<FONT color="green">100</FONT>            {<a name="line.100"></a>
<FONT color="green">101</FONT>                int length = Array.getLength(value);<a name="line.101"></a>
<FONT color="green">102</FONT>                for (int i = 0; i &lt; length; i++)<a name="line.102"></a>
<FONT color="green">103</FONT>                {<a name="line.103"></a>
<FONT color="green">104</FONT>                    getConfiguration().addProperty(name, Array.get(value, i));<a name="line.104"></a>
<FONT color="green">105</FONT>                }<a name="line.105"></a>
<FONT color="green">106</FONT>            }<a name="line.106"></a>
<FONT color="green">107</FONT>            else<a name="line.107"></a>
<FONT color="green">108</FONT>            {<a name="line.108"></a>
<FONT color="green">109</FONT>                getConfiguration().setProperty(name, value);<a name="line.109"></a>
<FONT color="green">110</FONT>            }<a name="line.110"></a>
<FONT color="green">111</FONT>        }<a name="line.111"></a>
<FONT color="green">112</FONT>    <a name="line.112"></a>
<FONT color="green">113</FONT>        public Object get(String name)<a name="line.113"></a>
<FONT color="green">114</FONT>        {<a name="line.114"></a>
<FONT color="green">115</FONT>            if (LOG.isTraceEnabled())<a name="line.115"></a>
<FONT color="green">116</FONT>            {<a name="line.116"></a>
<FONT color="green">117</FONT>                LOG.trace("get(" + name + ")");<a name="line.117"></a>
<FONT color="green">118</FONT>            }<a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>            // get configuration property<a name="line.120"></a>
<FONT color="green">121</FONT>            Object result = getConfiguration().getProperty(name);<a name="line.121"></a>
<FONT color="green">122</FONT>            if (result == null)<a name="line.122"></a>
<FONT color="green">123</FONT>            {<a name="line.123"></a>
<FONT color="green">124</FONT>                // otherwise attempt to create bean from configuration subset<a name="line.124"></a>
<FONT color="green">125</FONT>                Configuration subset = new SubsetConfiguration(getConfiguration(), name, PROPERTY_DELIMITER);<a name="line.125"></a>
<FONT color="green">126</FONT>                if (!subset.isEmpty())<a name="line.126"></a>
<FONT color="green">127</FONT>                {<a name="line.127"></a>
<FONT color="green">128</FONT>                    result = new ConfigurationDynaBean(subset);<a name="line.128"></a>
<FONT color="green">129</FONT>                }<a name="line.129"></a>
<FONT color="green">130</FONT>            }<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>            if (LOG.isDebugEnabled())<a name="line.132"></a>
<FONT color="green">133</FONT>            {<a name="line.133"></a>
<FONT color="green">134</FONT>                LOG.debug(name + "=[" + result + "]");<a name="line.134"></a>
<FONT color="green">135</FONT>            }<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>            if (result == null)<a name="line.137"></a>
<FONT color="green">138</FONT>            {<a name="line.138"></a>
<FONT color="green">139</FONT>                throw new IllegalArgumentException("Property '" + name + "' does not exist.");<a name="line.139"></a>
<FONT color="green">140</FONT>            }<a name="line.140"></a>
<FONT color="green">141</FONT>            return result;<a name="line.141"></a>
<FONT color="green">142</FONT>        }<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>        public boolean contains(String name, String key)<a name="line.144"></a>
<FONT color="green">145</FONT>        {<a name="line.145"></a>
<FONT color="green">146</FONT>            Configuration subset = getConfiguration().subset(name);<a name="line.146"></a>
<FONT color="green">147</FONT>            if (subset == null)<a name="line.147"></a>
<FONT color="green">148</FONT>            {<a name="line.148"></a>
<FONT color="green">149</FONT>                throw new IllegalArgumentException("Mapped property '" + name + "' does not exist.");<a name="line.149"></a>
<FONT color="green">150</FONT>            }<a name="line.150"></a>
<FONT color="green">151</FONT>    <a name="line.151"></a>
<FONT color="green">152</FONT>            return subset.containsKey(key);<a name="line.152"></a>
<FONT color="green">153</FONT>        }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>        public Object get(String name, int index)<a name="line.155"></a>
<FONT color="green">156</FONT>        {<a name="line.156"></a>
<FONT color="green">157</FONT>            if (!checkIndexedProperty(name))<a name="line.157"></a>
<FONT color="green">158</FONT>            {<a name="line.158"></a>
<FONT color="green">159</FONT>                throw new IllegalArgumentException("Property '" + name<a name="line.159"></a>
<FONT color="green">160</FONT>                        + "' is not indexed.");<a name="line.160"></a>
<FONT color="green">161</FONT>            }<a name="line.161"></a>
<FONT color="green">162</FONT>    <a name="line.162"></a>
<FONT color="green">163</FONT>            List&lt;Object&gt; list = getConfiguration().getList(name);<a name="line.163"></a>
<FONT color="green">164</FONT>            return list.get(index);<a name="line.164"></a>
<FONT color="green">165</FONT>        }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>        public Object get(String name, String key)<a name="line.167"></a>
<FONT color="green">168</FONT>        {<a name="line.168"></a>
<FONT color="green">169</FONT>            Configuration subset = getConfiguration().subset(name);<a name="line.169"></a>
<FONT color="green">170</FONT>            if (subset == null)<a name="line.170"></a>
<FONT color="green">171</FONT>            {<a name="line.171"></a>
<FONT color="green">172</FONT>                throw new IllegalArgumentException("Mapped property '" + name + "' does not exist.");<a name="line.172"></a>
<FONT color="green">173</FONT>            }<a name="line.173"></a>
<FONT color="green">174</FONT>    <a name="line.174"></a>
<FONT color="green">175</FONT>            return subset.getProperty(key);<a name="line.175"></a>
<FONT color="green">176</FONT>        }<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>        public DynaClass getDynaClass()<a name="line.178"></a>
<FONT color="green">179</FONT>        {<a name="line.179"></a>
<FONT color="green">180</FONT>            return new ConfigurationDynaClass(getConfiguration());<a name="line.180"></a>
<FONT color="green">181</FONT>        }<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>        public void remove(String name, String key)<a name="line.183"></a>
<FONT color="green">184</FONT>        {<a name="line.184"></a>
<FONT color="green">185</FONT>            Configuration subset = new SubsetConfiguration(getConfiguration(), name, PROPERTY_DELIMITER);<a name="line.185"></a>
<FONT color="green">186</FONT>            subset.setProperty(key, null);<a name="line.186"></a>
<FONT color="green">187</FONT>        }<a name="line.187"></a>
<FONT color="green">188</FONT>    <a name="line.188"></a>
<FONT color="green">189</FONT>        public void set(String name, int index, Object value)<a name="line.189"></a>
<FONT color="green">190</FONT>        {<a name="line.190"></a>
<FONT color="green">191</FONT>            if (!checkIndexedProperty(name) &amp;&amp; index &gt; 0)<a name="line.191"></a>
<FONT color="green">192</FONT>            {<a name="line.192"></a>
<FONT color="green">193</FONT>                throw new IllegalArgumentException("Property '" + name<a name="line.193"></a>
<FONT color="green">194</FONT>                        + "' is not indexed.");<a name="line.194"></a>
<FONT color="green">195</FONT>            }<a name="line.195"></a>
<FONT color="green">196</FONT>    <a name="line.196"></a>
<FONT color="green">197</FONT>            Object property = getConfiguration().getProperty(name);<a name="line.197"></a>
<FONT color="green">198</FONT>    <a name="line.198"></a>
<FONT color="green">199</FONT>            if (property instanceof List)<a name="line.199"></a>
<FONT color="green">200</FONT>            {<a name="line.200"></a>
<FONT color="green">201</FONT>                // This is safe because multiple values of a configuration property<a name="line.201"></a>
<FONT color="green">202</FONT>                // are always stored as lists of type Object.<a name="line.202"></a>
<FONT color="green">203</FONT>                @SuppressWarnings("unchecked")<a name="line.203"></a>
<FONT color="green">204</FONT>                List&lt;Object&gt; list = (List&lt;Object&gt;) property;<a name="line.204"></a>
<FONT color="green">205</FONT>                list.set(index, value);<a name="line.205"></a>
<FONT color="green">206</FONT>                getConfiguration().setProperty(name, list);<a name="line.206"></a>
<FONT color="green">207</FONT>            }<a name="line.207"></a>
<FONT color="green">208</FONT>            else if (property.getClass().isArray())<a name="line.208"></a>
<FONT color="green">209</FONT>            {<a name="line.209"></a>
<FONT color="green">210</FONT>                Array.set(property, index, value);<a name="line.210"></a>
<FONT color="green">211</FONT>            }<a name="line.211"></a>
<FONT color="green">212</FONT>            else if (index == 0)<a name="line.212"></a>
<FONT color="green">213</FONT>            {<a name="line.213"></a>
<FONT color="green">214</FONT>                getConfiguration().setProperty(name, value);<a name="line.214"></a>
<FONT color="green">215</FONT>            }<a name="line.215"></a>
<FONT color="green">216</FONT>        }<a name="line.216"></a>
<FONT color="green">217</FONT>    <a name="line.217"></a>
<FONT color="green">218</FONT>        public void set(String name, String key, Object value)<a name="line.218"></a>
<FONT color="green">219</FONT>        {<a name="line.219"></a>
<FONT color="green">220</FONT>            getConfiguration().setProperty(name + "." + key, value);<a name="line.220"></a>
<FONT color="green">221</FONT>        }<a name="line.221"></a>
<FONT color="green">222</FONT>    <a name="line.222"></a>
<FONT color="green">223</FONT>        /**<a name="line.223"></a>
<FONT color="green">224</FONT>         * Tests whether the given name references an indexed property. This<a name="line.224"></a>
<FONT color="green">225</FONT>         * implementation tests for properties of type list or array. If the<a name="line.225"></a>
<FONT color="green">226</FONT>         * property does not exist, an exception is thrown.<a name="line.226"></a>
<FONT color="green">227</FONT>         *<a name="line.227"></a>
<FONT color="green">228</FONT>         * @param name the name of the property to check<a name="line.228"></a>
<FONT color="green">229</FONT>         * @return a flag whether this is an indexed property<a name="line.229"></a>
<FONT color="green">230</FONT>         * @throws IllegalArgumentException if the property does not exist<a name="line.230"></a>
<FONT color="green">231</FONT>         */<a name="line.231"></a>
<FONT color="green">232</FONT>        private boolean checkIndexedProperty(String name)<a name="line.232"></a>
<FONT color="green">233</FONT>        {<a name="line.233"></a>
<FONT color="green">234</FONT>            Object property = getConfiguration().getProperty(name);<a name="line.234"></a>
<FONT color="green">235</FONT>    <a name="line.235"></a>
<FONT color="green">236</FONT>            if (property == null)<a name="line.236"></a>
<FONT color="green">237</FONT>            {<a name="line.237"></a>
<FONT color="green">238</FONT>                throw new IllegalArgumentException("Property '" + name<a name="line.238"></a>
<FONT color="green">239</FONT>                        + "' does not exist.");<a name="line.239"></a>
<FONT color="green">240</FONT>            }<a name="line.240"></a>
<FONT color="green">241</FONT>    <a name="line.241"></a>
<FONT color="green">242</FONT>            return (property instanceof List) || property.getClass().isArray();<a name="line.242"></a>
<FONT color="green">243</FONT>        }<a name="line.243"></a>
<FONT color="green">244</FONT>    }<a name="line.244"></a>




























































</PRE>
</BODY>
</HTML>
